home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1994 November: Tool Chest / Dev.CD Nov 94.toast / Tool Chest / Development Tools & Languages / Macintosh Common Lisp Related / interfaces / QuickTime™ 1.0 Interfaces / Components.lisp < prev    next >
Encoding:
Text File  |  1993-09-16  |  11.2 KB  |  292 lines  |  [TEXT/CCL2]
  1.  
  2. (in-package :TRAPS)
  3. ; 
  4. ; Created: Wednesday, August 14, 1991 at 12:11 PM
  5. ;  Components.p
  6. ;  Pascal Interface to the Macintosh Libraries
  7. ; 
  8. ;  Copyright Apple Computer, Inc. 1990 - 1991
  9. ;  All rights reserved
  10. ; 
  11. ; 
  12.  
  13. ; $IFC UNDEFINED UsingIncludes
  14. ; $SETC UsingIncludes := 0
  15. ; $ENDC
  16.  
  17. ; $IFC NOT UsingIncludes
  18.  
  19. ; $ENDC
  20.  
  21. ; $IFC UNDEFINED UsingComponents
  22. ; $SETC UsingComponents := 1
  23.  
  24. ; $I+
  25. ; $SETC ComponentsIncludes := UsingIncludes
  26. ; $SETC UsingIncludes := 1
  27. ; $IFC UNDEFINED UsingTypes
  28.  
  29. (require-interface 'TYPES)      ; $I $$Shell(PInterfaces)Types.p
  30. ; $ENDC
  31. ; $SETC UsingIncludes := ComponentsIncludes
  32.  
  33. (defconstant $gestaltComponentMgr :|cpnt|)
  34.  
  35. (defconstant $kAnyComponentType 0)
  36. (defconstant $kAnyComponentSubType 0)
  37. (defconstant $kAnyComponentManufacturer 0)
  38. (defconstant $kAnyComponentFlagsMask 0)
  39.  
  40. (defconstant $cmpWantsRegisterMessage #X80000000)
  41.  
  42. (defrecord ComponentDescription 
  43.    (componentType :OSTYPE)      ;  A unique 4-byte code indentifying the command set 
  44.    (componentSubType :OSTYPE)   ;  Particular flavor of this instance 
  45.    (componentManufacturer :OSTYPE);  Vendor indentification 
  46.    (componentFlags :SIGNED-LONG);  8 each for Component,Type,SubType,Manuf/revision 
  47.    (componentFlagsMask :SIGNED-LONG);  Mask for specifying which flags to consider in search, zero during registration 
  48.    )
  49.  
  50. (defrecord ResourceSpec 
  51.    (resType :OSTYPE)            ;  4-byte code  
  52.    (resId :SIGNED-INTEGER)      ;     
  53.    )
  54.  
  55. (def-mactype :COMPONENTRESOURCEPTR (find-mactype :POINTER))
  56. (def-mactype :COMPONENTRESOURCEHANDLE (find-mactype :HANDLE))
  57. (defrecord (ComponentResource :handle) 
  58.    (cd :COMPONENTDESCRIPTION)   ;  Registration parameters 
  59.    (component :RESOURCESPEC)    ;  resource where Component code is found 
  60.    (componentName :RESOURCESPEC);  name string resource 
  61.    (componentInfo :RESOURCESPEC);  info string resource 
  62.    (componentIcon :RESOURCESPEC);  icon resource 
  63.    )
  64.  
  65. ;  Structure received by Component:  
  66. (defrecord ComponentParameters 
  67.    (flags :CHARACTER)           ;  call modifiers: sync/async, deferred, immed, etc 
  68.    (paramSize :CHARACTER)       ;  size in bytes of actual parameters passed to this call 
  69.    (what :SIGNED-INTEGER)       ;  routine selector, negative for Component management calls 
  70.    (params (:ARRAY :SIGNED-LONG 1));  actual parameters for the indicated routine 
  71.    )
  72.  
  73. (def-mactype :COMPONENT (find-mactype :POINTER))
  74. (defrecord ComponentRecord 
  75.    (data (:ARRAY :SIGNED-LONG 1))
  76.    )
  77.  
  78. (def-mactype :COMPONENTINSTANCE (find-mactype :POINTER))
  79. (defrecord ComponentInstanceRecord 
  80.    (data (:ARRAY :SIGNED-LONG 1))
  81.    )
  82.  
  83. (def-mactype :COMPONENTRESULT (find-mactype :SIGNED-LONG))
  84.  
  85. (def-mactype :COMPONENTROUTINE (find-mactype :SIGNED-LONG))
  86.  
  87. (def-mactype :COMPONENTFUNCTION (find-mactype :SIGNED-LONG))
  88.  
  89. ;  *******************************************************
  90. ; *                                                     *
  91. ; *              APPLICATION LEVEL CALLS                *
  92. ; *                                                     *
  93. ; *******************************************************
  94. ; * Component Database Add, Delete, and Query Routines 
  95. ; *******************************************************
  96. ;  
  97.  
  98. (deftrap _REGISTERCOMPONENT ((CD :COMPONENTDESCRIPTION) (COMPONENTENTRYPOINT :SIGNED-LONG) (GLOBAL :SIGNED-INTEGER) (COMPONENTNAME :HANDLE) (COMPONENTINFO :HANDLE) (COMPONENTICON :HANDLE))
  99.    (:STACK (:POINTER :COMPONENTRECORD))
  100.    (:STACK-TRAP #xA82A :D0 1 CD COMPONENTENTRYPOINT GLOBAL COMPONENTNAME COMPONENTINFO COMPONENTICON))
  101.  
  102. (deftrap _REGISTERCOMPONENTRESOURCE ((TR (:HANDLE :COMPONENTRESOURCE)) (GLOBAL :SIGNED-INTEGER))
  103.    (:STACK (:POINTER :COMPONENTRECORD))
  104.    (:STACK-TRAP #xA82A :D0 18 TR GLOBAL))
  105.  
  106. (deftrap _UNREGISTERCOMPONENT ((ACOMPONENT (:POINTER :COMPONENTRECORD)))
  107.    (:STACK :SIGNED-INTEGER)
  108.    (:STACK-TRAP #xA82A :D0 2 ACOMPONENT))
  109.  
  110.  
  111. (deftrap _FINDNEXTCOMPONENT ((ACOMPONENT (:POINTER :COMPONENTRECORD)) (LOOKING :COMPONENTDESCRIPTION))
  112.    (:STACK (:POINTER :COMPONENTRECORD))
  113.    (:STACK-TRAP #xA82A :D0 4 ACOMPONENT LOOKING))
  114.  
  115. (deftrap _COUNTCOMPONENTS ((LOOKING :COMPONENTDESCRIPTION))
  116.    (:STACK :SIGNED-LONG)
  117.    (:STACK-TRAP #xA82A :D0 3 LOOKING))
  118.  
  119.  
  120. (deftrap _GETCOMPONENTINFO ((ACOMPONENT (:POINTER :COMPONENTRECORD)) (CD :COMPONENTDESCRIPTION) (COMPONENTNAME :HANDLE) (COMPONENTINFO :HANDLE) (COMPONENTICON :HANDLE))
  121.    (:STACK :SIGNED-INTEGER)
  122.    (:STACK-TRAP #xA82A :D0 5 ACOMPONENT CD COMPONENTNAME COMPONENTINFO COMPONENTICON))
  123.  
  124. (deftrap _GETCOMPONENTLISTMODSEED NIL
  125.    (:STACK :SIGNED-LONG)
  126.    (:STACK-TRAP #xA82A :D0 6))
  127.  
  128. ;  *******************************************************
  129. ; * Component Instance Allocation and dispatch routines 
  130. ; *******************************************************
  131. ;  
  132.  
  133. (deftrap _OPENCOMPONENT ((ACOMPONENT (:POINTER :COMPONENTRECORD)))
  134.    (:STACK (:POINTER :COMPONENTINSTANCERECORD))
  135.    (:STACK-TRAP #xA82A :D0 7 ACOMPONENT))
  136.  
  137. (deftrap _CLOSECOMPONENT ((ACOMPONENTINSTANCE (:POINTER :COMPONENTINSTANCERECORD)))
  138.    (:STACK :SIGNED-INTEGER)
  139.    (:STACK-TRAP #xA82A :D0 8 ACOMPONENTINSTANCE))
  140.  
  141.  
  142. (deftrap _GETCOMPONENTINSTANCEERROR ((ACOMPONENTINSTANCE (:POINTER :COMPONENTINSTANCERECORD)))
  143.    (:STACK :SIGNED-INTEGER)
  144.    (:STACK-TRAP #xA82A :D0 10 ACOMPONENTINSTANCE))
  145.  
  146. ;   direct calls to the Components  
  147.  
  148. (deftrap _COMPONENTFUNCTIONIMPLEMENTED ((CI (:POINTER :COMPONENTINSTANCERECORD)) (FTNNUMBER :SIGNED-INTEGER))
  149.    (:STACK :SIGNED-LONG)
  150.    (:STACK-TRAP #xA82A :D0 0 CI FTNNUMBER ((+ (ASH 2 16) 65533) :SIGNED-LONGINT)))
  151.  
  152. (deftrap _GETCOMPONENTVERSION ((CI (:POINTER :COMPONENTINSTANCERECORD)))
  153.    (:STACK :SIGNED-LONG)
  154.    (:STACK-TRAP #xA82A :D0 0 CI ((+ (ASH 0 16) 65532) :SIGNED-LONGINT)))
  155.  
  156. ; ****************************************************
  157. ; *                                                    *
  158. ; *               CALLS MADE BY Components             *
  159. ; *                                                    *
  160. ; ******************************************************
  161. ; ******************************************************
  162. ; * Required Component routines
  163. ; ******************************************************
  164.  
  165. (defconstant $kComponentOpenSelect -1);  ComponentInstance for this open 
  166. (defconstant $kComponentCloseSelect -2);  ComponentInstance for this close 
  167. (defconstant $kComponentCanDoSelect -3);  selector # being queried 
  168. (defconstant $kComponentVersionSelect -4);  no params 
  169. (defconstant $kComponentRegisterSelect -5);  no params 
  170. (defconstant $kComponentTargetSelect -6);  ComponentInstance for top of call chain 
  171.  
  172. ;  *******************************************************
  173. ; * Component Management routines
  174. ; *******************************************************
  175. ;  
  176.  
  177. (deftrap _SETCOMPONENTINSTANCEERROR ((ACOMPONENTINSTANCE (:POINTER :COMPONENTINSTANCERECORD)) (THEERROR :SIGNED-INTEGER))
  178.    NIL
  179.    (:STACK-TRAP #xA82A :D0 11 ACOMPONENTINSTANCE THEERROR))
  180.  
  181.  
  182. (deftrap _GETCOMPONENTREFCON ((ACOMPONENT (:POINTER :COMPONENTRECORD)))
  183.    (:STACK :SIGNED-LONG)
  184.    (:STACK-TRAP #xA82A :D0 16 ACOMPONENT))
  185.  
  186. (deftrap _SETCOMPONENTREFCON ((ACOMPONENT (:POINTER :COMPONENTRECORD)) (THEREFCON :SIGNED-LONG))
  187.    NIL
  188.    (:STACK-TRAP #xA82A :D0 17 ACOMPONENT THEREFCON))
  189.  
  190.  
  191. (deftrap _OPENCOMPONENTRESFILE ((ACOMPONENT (:POINTER :COMPONENTRECORD)))
  192.    (:STACK :SIGNED-INTEGER)
  193.    (:STACK-TRAP #xA82A :D0 21 ACOMPONENT))
  194.  
  195. (deftrap _CLOSECOMPONENTRESFILE ((REFNUM :SIGNED-INTEGER))
  196.    (:STACK :SIGNED-INTEGER)
  197.    (:STACK-TRAP #xA82A :D0 24 REFNUM))
  198.  
  199. ;  *******************************************************
  200. ; * Component Instance Management routines
  201. ; *******************************************************
  202. ;  
  203.  
  204. (deftrap _GETCOMPONENTINSTANCESTORAGE ((ACOMPONENTINSTANCE (:POINTER :COMPONENTINSTANCERECORD)))
  205.    (:STACK :HANDLE)
  206.    (:STACK-TRAP #xA82A :D0 12 ACOMPONENTINSTANCE))
  207.  
  208. (deftrap _SETCOMPONENTINSTANCESTORAGE ((ACOMPONENTINSTANCE (:POINTER :COMPONENTINSTANCERECORD)) (THESTORAGE :HANDLE))
  209.    NIL
  210.    (:STACK-TRAP #xA82A :D0 13 ACOMPONENTINSTANCE THESTORAGE))
  211.  
  212.  
  213. (deftrap _GETCOMPONENTINSTANCEA5 ((ACOMPONENTINSTANCE (:POINTER :COMPONENTINSTANCERECORD)))
  214.    (:STACK :SIGNED-LONG)
  215.    (:STACK-TRAP #xA82A :D0 14 ACOMPONENTINSTANCE))
  216.  
  217. (deftrap _SETCOMPONENTINSTANCEA5 ((ACOMPONENTINSTANCE (:POINTER :COMPONENTINSTANCERECORD)) (THEA5 :SIGNED-LONG))
  218.    NIL
  219.    (:STACK-TRAP #xA82A :D0 15 ACOMPONENTINSTANCE THEA5))
  220.  
  221.  
  222. (deftrap _COUNTCOMPONENTINSTANCES ((ACOMPONENT (:POINTER :COMPONENTRECORD)))
  223.    (:STACK :SIGNED-LONG)
  224.    (:STACK-TRAP #xA82A :D0 19 ACOMPONENT))
  225.  
  226. ;   useful helper routines for convenient method dispatching  
  227.  
  228. (deftrap _CALLCOMPONENTFUNCTION ((PARAMS :COMPONENTPARAMETERS) (FUNC :SIGNED-LONG))
  229.    (:STACK :SIGNED-LONG)
  230.    (:STACK-TRAP #xA82A :D0 255 PARAMS FUNC))
  231.  
  232. (deftrap _CALLCOMPONENTFUNCTIONWITHSTORAGE ((STORAGE :HANDLE) (PARAMS :COMPONENTPARAMETERS) (FUNC :SIGNED-LONG))
  233.    (:STACK :SIGNED-LONG)
  234.    (:STACK-TRAP #xA82A :D0 255 STORAGE PARAMS FUNC))
  235.  
  236. (deftrap _DELEGATECOMPONENTCALL ((ORIGINALPARAMS :COMPONENTPARAMETERS) (CI (:POINTER :COMPONENTINSTANCERECORD)))
  237.    (:STACK :SIGNED-LONG)
  238.    (:STACK-TRAP #xA82A :D0 36 ORIGINALPARAMS CI))
  239.  
  240. ;  Set Default Component flags 
  241. (defconstant $defaultComponentIdentical 0)
  242. (defconstant $defaultComponentAnyFlags 1)
  243. (defconstant $defaultComponentAnyManufacturer 2)
  244. (defconstant $defaultComponentAnySubType 4)
  245. (defconstant $defaultComponentAnyFlagsAnyManufacturer (+ #$DEFAULTCOMPONENTANYFLAGS #$DEFAULTCOMPONENTANYMANUFACTURER))
  246. (defconstant $defaultComponentAnyFlagsAnyManufacturerAnySubType (+ #$DEFAULTCOMPONENTANYFLAGS (+ #$DEFAULTCOMPONENTANYMANUFACTURER #$DEFAULTCOMPONENTANYSUBTYPE)))
  247.  
  248.  
  249. (deftrap _SETDEFAULTCOMPONENT ((ACOMPONENT (:POINTER :COMPONENTRECORD)) (FLAGS :SIGNED-INTEGER))
  250.    (:STACK :SIGNED-INTEGER)
  251.    (:STACK-TRAP #xA82A :D0 30 ACOMPONENT FLAGS))
  252.  
  253. (deftrap _OPENDEFAULTCOMPONENT ((COMPONENTTYPE :OSTYPE) (COMPONENTSUBTYPE :OSTYPE))
  254.    (:STACK (:POINTER :COMPONENTINSTANCERECORD))
  255.    (:STACK-TRAP #xA82A :D0 33 COMPONENTTYPE COMPONENTSUBTYPE))
  256.  
  257. (deftrap _CAPTURECOMPONENT ((CAPTUREDCOMPONENT (:POINTER :COMPONENTRECORD)) (CAPTURINGCOMPONENT (:POINTER :COMPONENTRECORD)))
  258.    (:STACK (:POINTER :COMPONENTRECORD))
  259.    (:STACK-TRAP #xA82A :D0 28 CAPTUREDCOMPONENT CAPTURINGCOMPONENT))
  260.  
  261. (deftrap _UNCAPTURECOMPONENT ((ACOMPONENT (:POINTER :COMPONENTRECORD)))
  262.    (:STACK :SIGNED-INTEGER)
  263.    (:STACK-TRAP #xA82A :D0 29 ACOMPONENT))
  264.  
  265. ;  errors from component manager & components 
  266. (defconstant $invalidComponentID -3000)
  267. (defconstant $validInstancesExist -3001)
  268. (defconstant $componentNotCaptured -3002)
  269. (defconstant $componentDontRegister -3003)
  270.  
  271. (defconstant $badComponentInstance #X80008001)
  272. (defconstant $badComponentSelector #X80008002)
  273.  
  274. ; $ENDC                         ;  UsingComponents 
  275.  
  276. ; $IFC NOT UsingIncludes
  277.  
  278. ; $ENDC
  279.  
  280.  
  281. (export '($BADCOMPONENTSELECTOR $BADCOMPONENTINSTANCE $COMPONENTDONTREGISTER
  282.           $COMPONENTNOTCAPTURED $VALIDINSTANCESEXIST $INVALIDCOMPONENTID
  283.           $DEFAULTCOMPONENTANYFLAGSANYMANUFACTURERANYSUBTYPE
  284.           $DEFAULTCOMPONENTANYFLAGSANYMANUFACTURER $DEFAULTCOMPONENTANYSUBTYPE
  285.           $DEFAULTCOMPONENTANYMANUFACTURER $DEFAULTCOMPONENTANYFLAGS
  286.           $DEFAULTCOMPONENTIDENTICAL $KCOMPONENTTARGETSELECT
  287.           $KCOMPONENTREGISTERSELECT $KCOMPONENTVERSIONSELECT
  288.           $KCOMPONENTCANDOSELECT $KCOMPONENTCLOSESELECT $KCOMPONENTOPENSELECT
  289.           $CMPWANTSREGISTERMESSAGE $KANYCOMPONENTFLAGSMASK
  290.           $KANYCOMPONENTMANUFACTURER $KANYCOMPONENTSUBTYPE $KANYCOMPONENTTYPE
  291.           $GESTALTCOMPONENTMGR))
  292. (provide-interface 'Components)